home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / mysql / scripts / mysql_tableinfo < prev    next >
Text File  |  2005-04-01  |  14KB  |  477 lines
  1. #!/usr/bin/perl -w
  2.  
  3. use strict;
  4. use Getopt::Long;
  5. use DBI;
  6.  
  7. =head1 NAME
  8.  
  9. mysql_tableinfo - creates and populates information tables with 
  10. the output of SHOW DATABASES, SHOW TABLES (or SHOW TABLE STATUS), 
  11. SHOW COLUMNS and SHOW INDEX.
  12.  
  13. This is version 1.1.
  14.  
  15. =head1 SYNOPSIS
  16.  
  17.   mysql_tableinfo [OPTIONS] database_to_write [database_like_wild] [table_like_wild]
  18.  
  19.   Do not backquote (``) database_to_write, 
  20.   and do not quote ('') database_like_wild or table_like_wild
  21.  
  22.   Examples:
  23.  
  24.   mysql_tableinfo info
  25.  
  26.   mysql_tableinfo info this_db
  27.  
  28.   mysql_tableinfo info %a% b%
  29.  
  30.   mysql_tableinfo info --clear-only
  31.  
  32.   mysql_tableinfo info --col --idx --table-status
  33.  
  34. =cut
  35.  
  36. # Documentation continued at end of file
  37.  
  38.  
  39. sub usage {
  40.     die @_,"\nExecute 'perldoc $0' for documentation\n";
  41. }
  42.  
  43. my %opt = (
  44.     'user'    => scalar getpwuid($>),
  45.     'host'      => "localhost",
  46.     'prefix'    => "", #to avoid 'use of uninitialized value...'
  47. );
  48. Getopt::Long::Configure(qw(no_ignore_case)); # disambuguate -p and -P
  49. GetOptions( \%opt,
  50.     "help",
  51.     "user|u=s",
  52.     "password|p=s",
  53.     "host|h=s",
  54.     "port|P=s",
  55.     "socket|S=s",
  56.     "tbl-status",
  57.     "col",
  58.     "idx",
  59.     "clear",
  60.     "clear-only",
  61.     "prefix=s",
  62.     "quiet|q",
  63. ) or usage("Invalid option");
  64.  
  65. if ($opt{'help'}) {usage();}
  66.  
  67. my ($db_to_write,$db_like_wild,$tbl_like_wild);
  68. if (@ARGV==0)
  69. {
  70.     usage("Not enough arguments");
  71. }
  72. $db_to_write="`$ARGV[0]`"; shift @ARGV;
  73. $db_like_wild=($ARGV[0])?$ARGV[0]:"%"; shift @ARGV;
  74. $tbl_like_wild=($ARGV[0])?$ARGV[0]:"%"; shift @ARGV;
  75. if (@ARGV>0) { usage("Too many arguments"); }
  76.  
  77. $0 = $1 if $0 =~ m:/([^/]+)$:;
  78.  
  79. my $info_db="`".$opt{'prefix'}."db`";
  80. my $info_tbl="`".$opt{'prefix'}."tbl".
  81.     (($opt{'tbl-status'})?"_status":"")."`";
  82. my $info_col="`".$opt{'prefix'}."col`";
  83. my $info_idx="`".$opt{'prefix'}."idx`";
  84.  
  85.  
  86. # --- connect to the database ---
  87.  
  88. my $dsn = ";host=$opt{'host'}";
  89. $dsn .= ";port=$opt{'port'}" if $opt{'port'};
  90. $dsn .= ";mysql_socket=$opt{'socket'}" if $opt{'socket'};
  91.  
  92. my $dbh = DBI->connect("dbi:mysql:$dsn;mysql_read_default_group=perl",
  93.                         $opt{'user'}, $opt{'password'},
  94. {
  95.     RaiseError => 1,
  96.     PrintError => 0,
  97.     AutoCommit => 1,
  98. });
  99.  
  100. $db_like_wild=$dbh->quote($db_like_wild);
  101. $tbl_like_wild=$dbh->quote($tbl_like_wild);
  102.  
  103. #Ask
  104.  
  105. if (!$opt{'quiet'})
  106. {
  107.     print "\n!! This program is doing to do:\n\n";
  108.     print "**DROP** TABLE ...\n" if ($opt{'clear'} or $opt{'clear-only'});
  109.     print "**DELETE** FROM ... WHERE `Database` LIKE $db_like_wild AND `Table` LIKE $tbl_like_wild
  110. **INSERT** INTO ...
  111.  
  112. on the following tables :\n";
  113.  
  114.     foreach  (($info_db, $info_tbl),
  115.           (($opt{'col'})?$info_col:()), 
  116.           (($opt{'idx'})?$info_idx:()))
  117.     {
  118.     print("  $db_to_write.$_\n");
  119.     }
  120.     print "\nContinue (you can skip this confirmation step with --quiet) ? (y|n) [n]";
  121.     if (<STDIN> !~ /^\s*y\s*$/i) 
  122.     {
  123.     print "Nothing done!\n";exit;
  124.     }
  125. }
  126.  
  127. if ($opt{'clear'} or $opt{'clear-only'}) 
  128. {
  129. #do not drop the $db_to_write database !
  130.     foreach  (($info_db, $info_tbl),
  131.           (($opt{'col'})?$info_col:()), 
  132.           (($opt{'idx'})?$info_idx:()))
  133.     {
  134.     $dbh->do("DROP TABLE IF EXISTS $db_to_write.$_");
  135.     }
  136.     if ($opt{'clear-only'}) 
  137.     {
  138.     print "Wrote to database $db_to_write .\n" unless ($opt{'quiet'});
  139.     exit; 
  140.     }
  141. }
  142.  
  143.  
  144. my %sth;
  145. my %extra_col_desc;
  146. my %row;
  147. my %done_create_table;
  148.  
  149. #create the $db_to_write database
  150. $dbh->do("CREATE DATABASE IF NOT EXISTS $db_to_write");
  151. $dbh->do("USE $db_to_write");
  152.  
  153. #get databases
  154. $sth{'db'}=$dbh->prepare("SHOW DATABASES LIKE $db_like_wild");
  155. $sth{'db'}->execute;
  156.  
  157. #create $info_db which will receive info about databases.
  158. #Ensure that the first column to be called "Database" (as SHOW DATABASES LIKE
  159. #returns a varying
  160. #column name (of the form "Database (%...)") which is not suitable)
  161. $extra_col_desc{'db'}=do_create_table("db",$info_db,undef,"`Database`");
  162. #we'll remember the type of the `Database` column (as returned by
  163. #SHOW DATABASES), which we will need when creating the next tables. 
  164.  
  165. #clear out-of-date info from this table 
  166. $dbh->do("DELETE FROM $info_db WHERE `Database` LIKE $db_like_wild"); 
  167.  
  168.  
  169. while ($row{'db'}=$sth{'db'}->fetchrow_arrayref) #go through all databases
  170. {
  171.  
  172. #insert the database name
  173.     $dbh->do("INSERT INTO $info_db VALUES("
  174.          .join(',' ,  ( map $dbh->quote($_), @{$row{'db'}} ) ).")" );
  175.  
  176. #for each database, get tables
  177.  
  178.     $sth{'tbl'}=$dbh->prepare("SHOW TABLE"
  179.                 .( ($opt{'tbl-status'}) ? 
  180.                    " STATUS"
  181.                    : "S" )
  182.                 ." from `$row{'db'}->[0]` LIKE $tbl_like_wild");
  183.     $sth{'tbl'}->execute;
  184.     unless ($done_create_table{$info_tbl})
  185.  
  186. #tables must be created only once, and out-of-date info must be
  187. #cleared once
  188.     {
  189.     $done_create_table{$info_tbl}=1;
  190.     $extra_col_desc{'tbl'}=
  191.         do_create_table("tbl",$info_tbl,
  192. #add an extra column (database name) at the left
  193. #and ensure that the table name will be called "Table"
  194. #(this is unncessesary with
  195. #SHOW TABLE STATUS, but necessary with SHOW TABLES (which returns a column
  196. #named "Tables_in_..."))
  197.                 "`Database` ".$extra_col_desc{'db'},"`Table`"); 
  198.     $dbh->do("DELETE FROM $info_tbl WHERE `Database` LIKE $db_like_wild                                 AND `Table` LIKE $tbl_like_wild");
  199.     }
  200.  
  201.     while ($row{'tbl'}=$sth{'tbl'}->fetchrow_arrayref)
  202.     {
  203.     $dbh->do("INSERT INTO $info_tbl VALUES("
  204.          .$dbh->quote($row{'db'}->[0]).","
  205.          .join(',' ,  ( map $dbh->quote($_), @{$row{'tbl'}} ) ).")");
  206.  
  207. #for each table, get columns...
  208.  
  209.     if ($opt{'col'})
  210.     {
  211.         $sth{'col'}=$dbh->prepare("SHOW COLUMNS FROM `$row{'tbl'}->[0]` FROM `$row{'db'}->[0]`"); 
  212.         $sth{'col'}->execute;
  213.         unless ($done_create_table{$info_col})
  214.         {
  215.         $done_create_table{$info_col}=1;
  216.         do_create_table("col",$info_col,
  217.                 "`Database` ".$extra_col_desc{'db'}.","
  218.                 ."`Table` ".$extra_col_desc{'tbl'}.","
  219.                 ."`Seq_in_table` BIGINT(3)"); 
  220. #We need to add a sequence number (1 for the first column of the table,
  221. #2 for the second etc) so that users are able to retrieve columns in order
  222. #if they want. This is not needed for INDEX 
  223. #(where there is already Seq_in_index)
  224.         $dbh->do("DELETE FROM $info_col WHERE `Database` 
  225.                             LIKE $db_like_wild
  226.                 AND `Table` LIKE $tbl_like_wild");
  227.         }
  228.         my $col_number=0;
  229.         while ($row{'col'}=$sth{'col'}->fetchrow_arrayref)
  230.         {
  231.         $dbh->do("INSERT INTO $info_col VALUES("
  232.              .$dbh->quote($row{'db'}->[0]).","
  233.              .$dbh->quote($row{'tbl'}->[0]).","
  234.              .++$col_number.","
  235.              .join(',' ,  ( map $dbh->quote($_), @{$row{'col'}} ) ).")");
  236.         }
  237.     }
  238.  
  239. #and get index.
  240.  
  241.     if ($opt{'idx'})
  242.     {
  243.         $sth{'idx'}=$dbh->prepare("SHOW INDEX FROM `$row{'tbl'}->[0]` FROM `$row{'db'}->[0]`"); 
  244.         $sth{'idx'}->execute;
  245.         unless ($done_create_table{$info_idx})
  246.         {
  247.         $done_create_table{$info_idx}=1;
  248.         do_create_table("idx",$info_idx,
  249.                 "`Database` ".$extra_col_desc{'db'});
  250.         $dbh->do("DELETE FROM $info_idx WHERE `Database`
  251.              LIKE $db_like_wild
  252.              AND `Table` LIKE $tbl_like_wild");
  253.         }
  254.         while ($row{'idx'}=$sth{'idx'}->fetchrow_arrayref)
  255.         {
  256.         $dbh->do("INSERT INTO $info_idx VALUES("
  257.              .$dbh->quote($row{'db'}->[0]).","
  258.              .join(',' ,  ( map $dbh->quote($_), @{$row{'idx'}} ) ).")");
  259.         }
  260.     }
  261.     }
  262. }
  263.  
  264. print "Wrote to database $db_to_write .\n" unless ($opt{'quiet'});
  265. exit;
  266.  
  267.  
  268. sub do_create_table
  269. {
  270.     my ($sth_key,$target_tbl,$extra_col_desc,$first_col_name)=@_; 
  271.     my $create_table_query=$extra_col_desc;
  272.     my ($i,$first_col_desc,$col_desc);
  273.  
  274.     for ($i=0;$i<$sth{$sth_key}->{NUM_OF_FIELDS};$i++)
  275.     {
  276.     if ($create_table_query) { $create_table_query.=", "; }    
  277.     $col_desc=$sth{$sth_key}->{mysql_type_name}->[$i];
  278.     if ($col_desc =~ /char|int/i)
  279.     {
  280.         $col_desc.="($sth{$sth_key}->{PRECISION}->[$i])";
  281.     }
  282.     elsif ($col_desc =~ /decimal|numeric/i) #(never seen that)
  283.     {
  284.         $col_desc.=
  285.         "($sth{$sth_key}->{PRECISION}->[$i],$sth{$sth_key}->{SCALE}->[$i])";
  286.     }
  287.     elsif ($col_desc !~ /date/i) #date and datetime are OK,
  288.                              #no precision or scale for them
  289.     {
  290.         warn "unexpected column type '$col_desc' 
  291. (neither 'char','int','decimal|numeric')
  292. when creating $target_tbl, hope table creation will go OK\n";
  293.     }
  294.     if ($i==0) {$first_col_desc=$col_desc};
  295.     $create_table_query.=
  296.         ( ($i==0 and $first_col_name) ? 
  297.           "$first_col_name " :"`$sth{$sth_key}->{NAME}->[$i]` " )
  298.         .$col_desc;
  299.     }
  300. if ($create_table_query)
  301. {
  302.     $dbh->do("CREATE TABLE IF NOT EXISTS $target_tbl ($create_table_query)");
  303. }
  304. return $first_col_desc;
  305. }
  306.  
  307. __END__
  308.  
  309.  
  310. =head1 DESCRIPTION
  311.  
  312. mysql_tableinfo asks a MySQL server information about its
  313. databases, tables, table columns and index, and stores this
  314. in tables called `db`, `tbl` (or `tbl_status`), `col`, `idx` 
  315. (with an optional prefix specified with --prefix).
  316. After that, you can query these information tables, for example
  317. to build your admin scripts with SQL queries, like
  318.  
  319. SELECT CONCAT("CHECK TABLE ",`database`,".",`table`," EXTENDED;") 
  320. FROM info.tbl WHERE ... ;
  321.  
  322. as people usually do with some other RDBMS
  323. (note: to increase the speed of your queries on the info tables,
  324. you may add some index on them).
  325.  
  326. The database_like_wild and table_like_wild instructs the program
  327. to gather information only about databases and tables
  328. whose names match these patterns. If the info
  329. tables already exist, their rows matching the patterns are simply
  330. deleted and replaced by the new ones. That is,
  331. old rows not matching the patterns are not touched.
  332. If the database_like_wild and table_like_wild arguments
  333. are not specified on the command-line they default to "%".
  334.  
  335. The program :
  336.  
  337. - does CREATE DATABASE IF NOT EXISTS database_to_write
  338. where database_to_write is the database name specified on the command-line.
  339.  
  340. - does CREATE TABLE IF NOT EXISTS database_to_write.`db`
  341.  
  342. - fills database_to_write.`db` with the output of
  343. SHOW DATABASES LIKE database_like_wild
  344.  
  345. - does CREATE TABLE IF NOT EXISTS database_to_write.`tbl`
  346. (respectively database_to_write.`tbl_status`
  347. if the --tbl-status option is on)
  348.  
  349. - for every found database,
  350. fills database_to_write.`tbl` (respectively database_to_write.`tbl_status`)
  351. with the output of 
  352. SHOW TABLES FROM found_db LIKE table_like_wild
  353. (respectively SHOW TABLE STATUS FROM found_db LIKE table_like_wild)
  354.  
  355. - if the --col option is on,
  356.     * does CREATE TABLE IF NOT EXISTS database_to_write.`col`
  357.     * for every found table,
  358.       fills database_to_write.`col` with the output of 
  359.       SHOW COLUMNS FROM found_tbl FROM found_db
  360.  
  361. - if the --idx option is on,
  362.     * does CREATE TABLE IF NOT EXISTS database_to_write.`idx`
  363.     * for every found table,
  364.       fills database_to_write.`idx` with the output of 
  365.       SHOW INDEX FROM found_tbl FROM found_db
  366.  
  367. Some options may modify this general scheme (see below).
  368.  
  369. As mentioned, the contents of the info tables are the output of
  370. SHOW commands. In fact the contents are slightly more complete :
  371.  
  372. - the `tbl` (or `tbl_status`) info table 
  373.   has an extra column which contains the database name,
  374.  
  375. - the `col` info table
  376.   has an extra column which contains the table name,
  377.   and an extra column which contains, for each described column,
  378.   the number of this column in the table owning it (this extra column
  379.   is called `Seq_in_table`). `Seq_in_table` makes it possible for you
  380.   to retrieve your columns in sorted order, when you are querying
  381.   the `col` table. 
  382.  
  383. - the `index` info table
  384.   has an extra column which contains the database name.
  385.  
  386. Caution: info tables contain certain columns (e.g.
  387. Database, Table, Null...) whose names, as they are MySQL reserved words,
  388. need to be backquoted (`...`) when used in SQL statements.
  389.  
  390. Caution: as information fetching and info tables filling happen at the
  391. same time, info tables may contain inaccurate information about
  392. themselves.
  393.  
  394. =head1 OPTIONS
  395.  
  396. =over 4
  397.  
  398. =item --clear
  399.  
  400. Does DROP TABLE on the info tables (only those that the program is
  401. going to fill, for example if you do not use --col it won't drop
  402. the `col` table) and processes normally. Does not drop database_to_write.
  403.  
  404. =item --clear-only
  405.  
  406. Same as --clear but exits after the DROPs.
  407.  
  408. =item --col
  409.  
  410. Adds columns information (into table `col`).
  411.  
  412. =item --idx
  413.  
  414. Adds index information (into table `idx`).
  415.  
  416. =item --prefix prefix
  417.  
  418. The info tables are named from the concatenation of prefix and,
  419. respectively, db, tbl (or tbl_status), col, idx. Do not quote ('')
  420. or backquote (``) prefix.
  421.  
  422. =item -q, --quiet
  423.  
  424. Does not warn you about what the script is going to do (DROP TABLE etc)
  425. and does not ask for a confirmation before starting.
  426.  
  427. =item --tbl-status
  428.  
  429. Instead of using SHOW TABLES, uses SHOW TABLE STATUS
  430. (much more complete information, but slower). 
  431.  
  432. =item --help
  433.  
  434. Display helpscreen and exit
  435.  
  436. =item -u, --user=#         
  437.  
  438. user for database login if not current user. Give a user
  439. who has sufficient privileges (CREATE, ...).
  440.  
  441. =item -p, --password=#     
  442.  
  443. password to use when connecting to server
  444.  
  445. =item -h, --host=#     
  446.  
  447. host to connect to
  448.  
  449. =item -P, --port=#         
  450.  
  451. port to use when connecting to server
  452.  
  453. =item -S, --socket=#         
  454.  
  455. UNIX domain socket to use when connecting to server
  456.  
  457. =head1 WARRANTY
  458.  
  459. This software is free and comes without warranty of any kind. You
  460. should never trust backup software without studying the code yourself.
  461. Study the code inside this script and only rely on it if I<you> believe
  462. that it does the right thing for you.
  463.  
  464. Patches adding bug fixes, documentation and new features are welcome.
  465.  
  466. =head1 TO DO
  467.  
  468. Use extended inserts to be faster (for servers with many databases
  469. or tables). But to do that, must care about net-buffer-length.
  470.  
  471. =head1 AUTHOR
  472.  
  473. 2002-06-18 Guilhem Bichot (guilhem.bichot@mines-paris.org)
  474.  
  475. And all the authors of mysqlhotcopy, which served as a model for 
  476. the structure of the program.
  477.